/*
 * Copyright (C) 2008 Rob Cash
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * StateTransition.java
 * 
 * Created on Jan 1, 2009 at 12:14:53 PM
 */

package org.robcash.commons.util;

/**
 * @param <T> Type of value contained by machine state
 * @author Rob
 */
public interface StateTransition<T> {

    /**
     * Get the name of the transition
     * @return Name of the transition
     */
    public String getName();

    /**
     * Get the origin state
     * @return Origin state
     */
    public State<T> getOrigin();

    /**
     * Get the destination state
     * @return Destination state
     */
    public State<T> getDestination();

    /**
     * Indicates if the transition is a one-way (directed) or two-way
     * (bidirectional)
     * @return <tt>false</tt> if the transition is one-way; <tt>true</tt> if the
     * transition is two-way
     */
    public boolean isTwoWay();
    
}
